<!-- HTML header for doxygen 1.8.9.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<meta name="robots" content="NOINDEX, NOFOLLOW" /> <!-- Prevent indexing by search engines -->
<title>Compute Library: arm_compute/runtime/MemoryRegion.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">Compute Library
   &#160;<span id="projectnumber">18.05</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.xhtml"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.xhtml"><span>Related&#160;Pages</span></a></li>
      <li><a href="namespaces.xhtml"><span>Namespaces</span></a></li>
      <li><a href="annotated.xhtml"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.xhtml"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.xhtml"><span>File&#160;List</span></a></li>
      <li><a href="globals.xhtml"><span>Globals</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_memory_region_8h_source.xhtml','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">MemoryRegion.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_memory_region_8h.xhtml">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> * Copyright (c) 2018 ARM Limited.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * SPDX-License-Identifier: MIT</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> * deal in the Software without restriction, including without limitation the</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * sell copies of the Software, and to permit persons to whom the Software is</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * The above copyright notice and this permission notice shall be included in all</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * copies or substantial portions of the Software.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * SOFTWARE.</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="preprocessor">#ifndef __ARM_COMPUTE_RUNTIME_MEMORY_REGION_H__</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#define __ARM_COMPUTE_RUNTIME_MEMORY_REGION_H__</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_i_memory_region_8h.xhtml">arm_compute/runtime/IMemoryRegion.h</a>&quot;</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_error_8h.xhtml">arm_compute/core/Error.h</a>&quot;</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#include &lt;cstddef&gt;</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacearm__compute.xhtml">arm_compute</a></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_region.xhtml">   36</a></span>&#160;<span class="keyword">class </span><a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> final : <span class="keyword">public</span> <a class="code" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_region.xhtml#a2506bd112d8f696eb7e2a8fb203b3952">   43</a></span>&#160;    <a class="code" href="classarm__compute_1_1_memory_region.xhtml#a2506bd112d8f696eb7e2a8fb203b3952">MemoryRegion</a>(<span class="keywordtype">size_t</span> <a class="code" href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">size</a>)</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        : <a class="code" href="classarm__compute_1_1_i_memory_region.xhtml">IMemoryRegion</a>(size), _mem(nullptr), _ptr(nullptr)</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    {</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;        <span class="keywordflow">if</span>(size != 0)</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        {</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;            _mem = std::shared_ptr&lt;uint8_t&gt;(<span class="keyword">new</span> uint8_t[<a class="code" href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">size</a>](), [](uint8_t *ptr)</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;            {</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;                <span class="keyword">delete</span>[] ptr;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;            });</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;            _ptr = _mem.get();</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;        }</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    }</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    <a class="code" href="classarm__compute_1_1_memory_region.xhtml#a2506bd112d8f696eb7e2a8fb203b3952">MemoryRegion</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> &amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;    <a class="code" href="classarm__compute_1_1_memory_region.xhtml#a2506bd112d8f696eb7e2a8fb203b3952">MemoryRegion</a>(<a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> &amp;&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;    <a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> &amp;<a class="code" href="classarm__compute_1_1_memory_region.xhtml#a56244352ef17c3750434e3fd479859cb">operator=</a>(<span class="keyword">const</span> <a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> &amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;    <a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> &amp;<a class="code" href="classarm__compute_1_1_memory_region.xhtml#a56244352ef17c3750434e3fd479859cb">operator=</a>(<a class="code" href="classarm__compute_1_1_memory_region.xhtml">MemoryRegion</a> &amp;&amp;) = <span class="keywordflow">default</span>;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;    <span class="comment">// Inherited methods overridden :</span></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_region.xhtml#ab9ec7ea42f2074a78cc2bf89e4663a24">   65</a></span>&#160;    <span class="keywordtype">void</span> *<a class="code" href="classarm__compute_1_1_memory_region.xhtml#ab9ec7ea42f2074a78cc2bf89e4663a24">buffer</a>() final</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;    {</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        <span class="keywordflow">return</span> _mem.get();</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;    }</div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_region.xhtml#a80776c0cd484c25f25e4e7d8198c4678">   69</a></span>&#160;    <span class="keywordtype">void</span> *<a class="code" href="classarm__compute_1_1_memory_region.xhtml#a80776c0cd484c25f25e4e7d8198c4678">buffer</a>() const final</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;    {</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        <span class="keywordflow">return</span> _mem.get();</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;    }</div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="classarm__compute_1_1_memory_region.xhtml#ac27e0ab016ec2b2db9f394e3cb70c061">   73</a></span>&#160;    <span class="keywordtype">void</span> **<a class="code" href="classarm__compute_1_1_memory_region.xhtml#ac27e0ab016ec2b2db9f394e3cb70c061">handle</a>() final</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;    {</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;        <span class="keywordflow">return</span> <span class="keyword">reinterpret_cast&lt;</span><span class="keywordtype">void</span> **<span class="keyword">&gt;</span>(&amp;_mem);</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;    }</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;<span class="keyword">protected</span>:</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;    std::shared_ptr&lt;uint8_t&gt; _mem;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    uint8_t                 *_ptr;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;};</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;} <span class="comment">// namespace arm_compute</span></div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* __ARM_COMPUTE_RUNTIME_MEMORY_REGION_H__ */</span><span class="preprocessor"></span></div><div class="ttc" id="classarm__compute_1_1_memory_region_xhtml_ab9ec7ea42f2074a78cc2bf89e4663a24"><div class="ttname"><a href="classarm__compute_1_1_memory_region.xhtml#ab9ec7ea42f2074a78cc2bf89e4663a24">arm_compute::MemoryRegion::buffer</a></div><div class="ttdeci">void * buffer() final</div><div class="ttdoc">Returns the pointer to the allocated data. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_region_8h_source.xhtml#l00065">MemoryRegion.h:65</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_region_xhtml_ac27e0ab016ec2b2db9f394e3cb70c061"><div class="ttname"><a href="classarm__compute_1_1_memory_region.xhtml#ac27e0ab016ec2b2db9f394e3cb70c061">arm_compute::MemoryRegion::handle</a></div><div class="ttdeci">void ** handle() final</div><div class="ttdoc">Handle of internal memory. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_region_8h_source.xhtml#l00073">MemoryRegion.h:73</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_region_xhtml"><div class="ttname"><a href="classarm__compute_1_1_i_memory_region.xhtml">arm_compute::IMemoryRegion</a></div><div class="ttdoc">Memory region interface. </div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_region_8h_source.xhtml#l00032">IMemoryRegion.h:32</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_region_xhtml"><div class="ttname"><a href="classarm__compute_1_1_memory_region.xhtml">arm_compute::MemoryRegion</a></div><div class="ttdoc">Memory region CPU implementation. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_region_8h_source.xhtml#l00036">MemoryRegion.h:36</a></div></div>
<div class="ttc" id="namespacearm__compute_xhtml"><div class="ttname"><a href="namespacearm__compute.xhtml">arm_compute</a></div><div class="ttdoc">This file contains all available output stages for GEMMLowp on OpenCL. </div><div class="ttdef"><b>Definition:</b> <a href="00__introduction_8dox_source.xhtml#l00001">00_introduction.dox:1</a></div></div>
<div class="ttc" id="_error_8h_xhtml"><div class="ttname"><a href="_error_8h.xhtml">Error.h</a></div></div>
<div class="ttc" id="classarm__compute_1_1_i_memory_region_xhtml_a0b6b70701c46e22849f0f363861351cd"><div class="ttname"><a href="classarm__compute_1_1_i_memory_region.xhtml#a0b6b70701c46e22849f0f363861351cd">arm_compute::IMemoryRegion::size</a></div><div class="ttdeci">size_t size()</div><div class="ttdoc">Memory region size accessor. </div><div class="ttdef"><b>Definition:</b> <a href="_i_memory_region_8h_source.xhtml#l00064">IMemoryRegion.h:64</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_region_xhtml_a80776c0cd484c25f25e4e7d8198c4678"><div class="ttname"><a href="classarm__compute_1_1_memory_region.xhtml#a80776c0cd484c25f25e4e7d8198c4678">arm_compute::MemoryRegion::buffer</a></div><div class="ttdeci">void * buffer() const final</div><div class="ttdoc">Returns the pointer to the allocated data. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_region_8h_source.xhtml#l00069">MemoryRegion.h:69</a></div></div>
<div class="ttc" id="_i_memory_region_8h_xhtml"><div class="ttname"><a href="_i_memory_region_8h.xhtml">IMemoryRegion.h</a></div></div>
<div class="ttc" id="classarm__compute_1_1_memory_region_xhtml_a56244352ef17c3750434e3fd479859cb"><div class="ttname"><a href="classarm__compute_1_1_memory_region.xhtml#a56244352ef17c3750434e3fd479859cb">arm_compute::MemoryRegion::operator=</a></div><div class="ttdeci">MemoryRegion &amp; operator=(const MemoryRegion &amp;)=delete</div><div class="ttdoc">Prevent instances of this class from being copied (As this class contains pointers) ...</div></div>
<div class="ttc" id="classarm__compute_1_1_memory_region_xhtml_a2506bd112d8f696eb7e2a8fb203b3952"><div class="ttname"><a href="classarm__compute_1_1_memory_region.xhtml#a2506bd112d8f696eb7e2a8fb203b3952">arm_compute::MemoryRegion::MemoryRegion</a></div><div class="ttdeci">MemoryRegion(size_t size)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> <a href="_memory_region_8h_source.xhtml#l00043">MemoryRegion.h:43</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_214608ef36d61442cb2b0c1c4e9a7def.xhtml">arm_compute</a></li><li class="navelem"><a class="el" href="dir_8bc26130589aa16388b5a02f17abf2c2.xhtml">runtime</a></li><li class="navelem"><a class="el" href="_memory_region_8h.xhtml">MemoryRegion.h</a></li>
    <li class="footer">Generated on Wed May 23 2018 11:36:36 for Compute Library by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
